home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib.fmt / misc / util.man < prev   
Text File  |  1991-11-15  |  3KB  |  69 lines
  1.  
  2.  
  3.  
  4. util                  C Library Procedures                   util
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NNAAMMEE
  11.      Util_CanonicalDir - Canonicalize a directory name to a  full
  12.      path.
  13.  
  14. SSYYNNOOPPSSIISS
  15.      ##iinncclluuddee <<uuttiill..hh>>
  16.  
  17.      char *
  18.      UUttiill__CCaannoonniiccaallDDiirr(_n_e_w_D_i_r, _c_u_r_r_e_n_t_D_i_r, _b_u_f_f_e_r)
  19.  
  20. AARRGGUUMMEENNTTSS
  21.      char          *_n_e_w_D_i_r       (in)      The new directory name
  22.                                            to canonicalize.
  23.  
  24.      char          *_c_u_r_r_e_n_t_D_i_r   (in)      The current  directory
  25.                                            (or   other  name)  to
  26.                                            which _n_e_w_D_i_r _i_s  _r_e_l_a_-
  27.                                            _t_i_v_e - _m_a_y _b_e _N_U_L_L.
  28.  
  29.      _c_h_a_r          *_b_u_f_f_e_r       (_i_n/_o_u_t)  Pre-allocated space in
  30.                                            which   to   put   new
  31.                                            canonicalized  name  -
  32.                                            may be NULL.
  33.  
  34. _________________________________________________________________
  35.  
  36.  
  37. DDEESSCCRRIIPPTTIIOONN
  38.      The procedure takes a directory name, _n_e_w_D_i_r, and  turns  it
  39.      into  a  full  path relative to a directory _c_u_r_r_e_n_t_D_i_r.  The
  40.      parameter _c_u_r_r_e_n_t_D_i_r can actually be any full pathname to  a
  41.      directory   but   is  usually  the  current  directory.   If
  42.      _c_u_r_r_e_n_t_D_i_r is NULL, the procedure calls _g_e_t_w_d() to find  the
  43.      full  path  name to the current directory.  If the parameter
  44.      _b_u_f_f_e_r is NULL, then the procedure allocates space  for  the
  45.      new  canonicalized  directory  name and returns a pointer to
  46.      that new string.  If _b_u_f_f_e_r is not NULL, then it must be  an
  47.      area  of  at  least  MAXPATHLEN characters in which the pro-
  48.      cedure will copy the computed canonicalized name.  A pointer
  49.      to  _b_u_f_f_e_r  is  then  returned.   It  is okay for _b_u_f_f_e_r and
  50.      _n_e_w_D_i_r to be the same physical string, since _n_e_w_D_i_r is  only
  51.      overwritten at the end of the computation.
  52.  
  53.      The procedure returns a pointer to a new  full  pathname  if
  54.      successful.  If there is a failure, it returns NULL, with an
  55.      error string in _b_u_f_f_e_r if that parameter was non-NULL.
  56.  
  57.  
  58. KKEEYYWWOORRDDSS
  59.      directory, path, pathname, full
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Sprite v.1.0       Printed:  November 15, 1991                  1
  66.  
  67.  
  68.  
  69.